home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
doors_2
/
sprscn3.zip
/
SUPRSCAN.DOC
< prev
next >
Wrap
Text File
|
1992-01-08
|
9KB
|
203 lines
SUPRSCAN
++++++++
version 3.05, by Michael Conley
released 01/08/92 from the Charlatan's Cabin BBS, Los Angeles, CA.
SUPRSCAN is designed to be run as a live DOOR program on Wildcat! 3.x and 2.x
systems. It allows your users to search through any BBS lists you provide,
by simply unzipping them and placing the TEXT files in a directory you define
in the configuration file for SUPRSCAN. Depending on list format, they may
search for Area Code, State, or a key word or phrase.
SETTING UP A DOOR:
==================
The Wildcat! manual and other tutorials have done a fine job of explaining
how to set up a door on your BBS. Therefore I won't re-invent the wheel by
going through all of the directory naming and batch file creating necessary
to execute SUPRSCAN.
It's important to note that SUPRSCAN will check the CURRENT directory (where
your DOOR program is started) for either DOOR.SYS or CALLINFO.BBS. Wildcat!
version 3.x creates DOOR.SYS; earlier versions created CALLINFO.BBS. On my
system, I have a directory called DOORS, and my batch file copies DOOR.SYS
into that directory, then change to that directory, then start SUPRSCAN.
SuperScan also needs ENVIRONMENT VARIABLES: These are used by Wildcat! 3.x
and will be ignored by Wildcat! 2.x, but they MUST be present for each node
of your Wildcat! system in order for SuperScan to function properly:
SET WCPORTID=2 < put these lines in your Wildcat! startup batch file and
SET WCIRQID=3 < check to be sure they are added to your environment.
If you have a non-standard port address, you'll need to provide an additional
environment variable with the DECIMAL port address:
SET COMBASE=1016 << substitute your correct decimal port address here.
That will override the default address of the port number specified in
WCPORTID. WCIRQID will still need to be set to the correct interrupt
value. SuperScan supports IRQs in the range 2-7.
A sample batch file for Wildcat! version 3.x would look something like this:
REM this is a sample batch file for SUPRSCAN with Wildcat! 3.x
REM this assumes you SHELL to your doors. If you TERMINATE, you
REM need to add a change-directory back to your startup directory
REM and then run your startup batch file.
ECHO OFF
COPY C:\WC30\WCWORK\NODE%WCNODEID%\DOOR.SYS C:\WC30\DOORS\DOOR.SYS
CD C:\WC30\DOORS\DOOR.SYS
SUPRSCAN
EXIT
A sample batch file for Wildcat! version 2.x would look something like this:
REM this is a sample batch file for SUPRSCAN with Wildcat! 2.x
ECHO OFF
CD \DOORS
COPY C:\CAT\NODE1\CALLINFO.BBS C:\DOORS\CALLINFO.BBS
SUPRSCAN
CD \CAT\NODE1
NODE1.BAT
Note that SUPRSCAN monitors time online and Carrier Detect, and will close
and exit gracefully back to the node if the caller drops offline while in
the door.
PREPARING SUPRSCAN:
===================
It's necessary to create a configuration file for SUPRSCAN, named SUPRSCAN.CFG,
which must reside in the directory where you'll start SUPRSCAN. Here is a
sample configuration file:
BBSNAME=The Charlatan's Cabin BBS
CTSCHECK=YES
LISTPATH=C:\WC30\DOORS
LISTNAME=The Southern California BBS List
LISTFILE=SOCAL???.LST
HEADERLINES=5
STARTMARK= =============
AREACOLUMN=3
STATECOLUMN=0
LISTNAME=Listing of 9600 baud BBSes
LISTFILE=96LIST??.TXT
HEADERLINES=3
STARTMARK= -----------------
AREACOLUMN=1
STATECOLUMN=59
You may edit this file as desired, following these guidelines:
BBSNAME= The name of your BBS as you want it to appear in
the program's displays.
CTSCHECK= Indicate YES or NO ... do you want the program to
check for Clear to Send? Default is YES if this
line isn't found.
LISTPATH= The complete Path to your BBS lists.
Next, you'll need to set up configuration information for each BBS list
you want to support in SuperScan. NOTE: You'll need to place ALL of the
lists in the directory defined in LISTPATH.
A maximum of 9 BBS lists may be included ... any beyond that will be
ignored.
For each BBS list, create a block of entries consisting of these six lines:
LISTNAME= The name of the list as you want it displayed on the
menu screen.
LISTFILE= The name of the BBS list file itself. Reasonable
wildcards are acceptable, such as "SOCAL???.LST" The
program's search routine will display the first
matching file, so be sure to delete old ones when you
receive a new list.
HEADERLINES= Indicates how many lines from the very top of the
list file you want to display. This might include
the name of the list, the compilation date, and
perhaps some information as to how the listing is
coded. I suggest you keep this to a fairly small
number because this info will be displayed each
time a search is initiated on a particular list.
STARTMARK= This is a little tricky ... it is a "text sample" of
a line in the file, after which you want to start the
search. Many lists have long headers including sample
listings which you don't want to include in the search.
Then, there will be a "tear-bar" or some keyword that
will indicate the beginning of the real list. Put a
unique chunk of that line after the STARTMARK option to
control where the search begins. Typically, a short line
of hyphens is often used, and the option might look
something like this: STARTMARK=---------------
AREACOLUMN= This indicates the column in which the area code is
listed. The program will look for an exact match of
the three-digit area code requested by the user,
beginning in this column. To disable this option, set
the value to 0, and the search mode will not be offered.
BE SURE TO TEST these options whenever you add or update
a list, as minor format changes can "break" SuperScan.
STATECOLUMN= This indicates the column in which to begin looking for
the state abbreviation. The program will look for an
exact match of the two-letter state abbreviation requested
by the user, anywhere between this column and the end of
the line. It will perform an "intelligent" search,
looking for either a SPACE or a COMMA before the state,
reducing the chances of bogus matches.
BE SURE TO TEST these options whenever you add or update
a list, as minor format changes can "break" SuperScan.
It's important to note that the block of options for each list must be filled
out completely, or SuperScan may produce unpredictable results! Also, be sure
to keep them in the order shown above. Do NOT omit any lines or SuperScan
will reject the configuration file.
------------------------------------------------------------------
PROBLEMS, SUGGESTIONS:
This program is public domain. I don't seek or accept any donations for
this or any of my other Wildcat! utility programs, including TODAYBBS,
FLOP, MSTAT, USTAT, and others.
I welcome suggestions, and will try to help (no guarantees) if there are
problems.
You may contact me at The Charlatan's Cabin BBS (213) 654-7337. Mention
your Wildcat! registration number in the comment and you'll be upgraded to
visiting sysop level without the usually required registration by mail.
You may also leave a message via CompuServe EMail. My CompuServe account
number is 70250,220. I also regularly check the Mustang Software head-
quarters BBS, especially the "3rd Party Utilities Help" conference.
Please, NO VOICE CALLS. This isn't meant to be unfriendly, but with the
price of public domain software these days ... I just can't afford to be
"on call." I WILL respond to your questions via my BBS or CompuServe,
or via the Mustang Software registered SysOp BBS.
Version history:
3.00 11/16/91 First release compatible with Wildcat! 3.x as well
as Wildcat! 2.x
3.01 11/22/91 Minor update ... added parsing to display time left
on sysop window at bottom of screen for systems
using DOOR.SYS
3.02 11/24/91 Added support for non-standard port addresses.
3.03 12/04/91 Minor enhancement to STATE search routine.
3.04 12/08/91 Minor bug fix to handle backspace from remote when
input line is empty.
3.05 01/08/92 Minor bug fix to correct menu display when the
maximum of 9 lists were configured.